New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Chore: Format style guide links so they can be clicked #12189
Conversation
When using the initializer and coming to style guide step, visual studio code terminal doesn't properly format style guide links so when user clicks on one of the links it takes them to e.q `https://github.com/airbnb/javascript)` (note the `)` at the end) Putting spaces between links and opening and closing braces fixes this.
Properly format styleguide links so they can be clicked
Hi @ivandotv, thanks for the PR. Wouldn't it be better to resolve this in Visual Studio Code? I'm not sure https://github.com/airbnb/javascript) is even a valid URL. |
Clicking the airbnb link goes to 404 page on github.com |
I think I'd be fine with this fix. It's so minor, it's not worth trying to push it off to VSCode (although it should also be reported there as well). |
I just think spaces in parentheses are kind of ugly. Can we come up with another approach here? Maybe remove the parentheses altogether and use some other approach? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there another approach we could take here? I don't really like this approach.
Are the URLs critical? What if we removed them entirely (but provided them some other way)? Or, could we use a different punctuator that VSCode won't trip on?
I also like it more with the colon. |
Feel free to do it! |
Remove braces around links and add a colon at the beginning.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
merged, thanks for contributing! |
What is the purpose of this pull request? (put an "X" next to item)
[ x ] Other, please explain:
What changes did you make? (Give an overview)
When initializing new eslint project and coming to style guide step, visual studio code terminal doesn't properly format style guide links so when user clicks on one of the links (in the terminal) it takes them to e.q
https://github.com/airbnb/javascript)
(note the)
at the end)Putting spaces after the opening brace and before the closing brace fixes this issue.
Is there anything you'd like reviewers to focus on?
No